Fixing bad componentId references #16868
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the WalkthroughThe documentation was updated to use more specific parameter names in code examples, replacing generic Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (4)
docs-v2/pages/connect/api.mdx(8 hunks)docs-v2/pages/connect/components.mdx(8 hunks)docs-v2/pages/connect/index.mdx(1 hunks)docs-v2/pages/connect/managed-auth/quickstart.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-v2/pages/connect/index.mdx
[misspelling] ~24-~24: This word is normally spelled as one.
Context: ...pi-proxy/) - Develop and deploy complex multi-step workflows in our...
(EN_COMPOUNDS_MULTI_STEP)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Lint Code Base
- GitHub Check: pnpm publish
- GitHub Check: validate-links
🔇 Additional comments (16)
docs-v2/pages/connect/components.mdx (3)
338-338: UsecomponentIdparameter forconfigureComponent
Replaced genericidwithcomponentIdin the API payload to align with theconfigureComponentmethod signature.
608-608: RenameidtoactionIdinrunActionpayload
Updated the payload to useactionId, matching the expected parameter name for invoking actions.
716-716: RenameidtotriggerIdindeployTriggerpayload
Switched the field name totriggerIdto reflect the correct API signature for deploying triggers.docs-v2/pages/connect/index.mdx (5)
12-12: Simplify heading to “Managed auth”
Removed the verb “Use” for a more concise and consistent section title.
19-19: Clarify section heading for user requests
Changed to “Make requests on behalf of your users” to more explicitly describe the section’s content.
21-21: Reference the MCP server in bullet
Updated the bullet to point to Pipedream’s MCP server, aligning with controlled terminology.
22-22: Broaden registry bullet scope
Adjusted wording to emphasize adding the full registry of pre-built tools and triggers.
24-24: Maintain imperative verb consistency
Ensured the list item “Develop and deploy complex multi-step workflows” follows the same imperative style as other bullets.🧰 Tools
🪛 LanguageTool
[misspelling] ~24-~24: This word is normally spelled as one.
Context: ...pi-proxy/) - Develop and deploy complex multi-step workflows in our...(EN_COMPOUNDS_MULTI_STEP)
docs-v2/pages/connect/api.mdx (8)
1453-1453: Clearer parameter naming for Configure Component
Renaming from the genericidfield tocomponentIdaligns the example with the SDK’s expectedconfigureComponentsignature and enhances readability.
1491-1491: ConsistentcomponentIdusage in JavaScript snippet
The JS example now correctly usescomponentIdinstead ofid, matching the TypeScript example and SDK API.
1665-1665: UsecomponentIdin Reload Component Props (TypeScript)
This update makes the prop-loading example self-documenting by specifyingcomponentIdexplicitly. Great for clarity.
1701-1701:componentIdin Reload Component Props (JavaScript)
The JS snippet now mirrors the TS example’s naming, improving consistency across languages.
1876-1876: RenameidtoactionIdin Invoke Action (TypeScript)
This change clarifies which identifier is required byrunActionin the SDK.
1919-1919:actionIdin Invoke Action (JavaScript)
Consistent with the TS example, the JS snippet now usesactionIdto avoid ambiguity.
2081-2081: Switch totriggerIdin Deploy Trigger (TypeScript)
UsingtriggerIdmakes it clear you’re deploying a trigger component rather than a generic resource.
2121-2121:triggerIdin Deploy Trigger (JavaScript)
Aligns the JS example with the TS version and the SDK’s parameter naming for deployTrigger.
…/pipedream into danny/connect-api-docs-typos
WHY
Summary by CodeRabbit
componentId,actionId,triggerId) instead of the genericidfor improved clarity.